Skip to content

fix(framework): point skill README symlinks to SKILL.md#331

Closed
alexsoyes wants to merge 9 commits into
mainfrom
codex/remove-skill-readmes
Closed

fix(framework): point skill README symlinks to SKILL.md#331
alexsoyes wants to merge 9 commits into
mainfrom
codex/remove-skill-readmes

Conversation

@alexsoyes

@alexsoyes alexsoyes commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

🎯 What & why

Replace direct per-skill README files with local symlinks to SKILL.md so the skill file remains the canonical source and no standalone README prose is maintained.

Plan: aidd_docs/tasks/2026_06/2026_06_26_remove-skill-readmes/plan.md

🛠️ How it works

  • Converts all direct plugins/*/skills/*/README.md entries to README.md -> SKILL.md symlinks.
  • Updates skill generation so plugin-source skill creation seeds README.md -> SKILL.md immediately after writing SKILL.md.
  • Keeps host-project skill generation focused on the target tool's SKILL.md and does not require README files.
  • Makes catalog generation skip direct skill README symlinks while keeping nested asset/template README files.
  • Updates contributor docs to describe the local symlink convention.

🧪 How to verify

  • pnpm exec lefthook run pre-commit --all-files --force
  • one-off assertion that every direct plugins/*/skills/*/README.md is a symlink to SKILL.md
  • git diff --check
  • npx --yes @ai-driven-dev/cli@4.6.1 framework build --source . --target codex --out "$(mktemp -d)" --flat

⚠️ Heads-up

No dedicated repository validator script is added; the durable behavior is seeded by the skill generator at creation time.

@alexsoyes alexsoyes changed the title chore(framework): replace skill READMEs with symlinks fix(framework): point skill README symlinks to SKILL.md Jun 26, 2026
@blafourcade

Copy link
Copy Markdown
Contributor

Superseded by #396 (merged). #396 removes the per-skill README.md files outright and retargets navigation links to SKILL.md, instead of symlinking.

Why not the symlink approach here:

  • Windows: without core.symlinks + privilege, git checks out README.md as a plain text file containing the literal string "SKILL.md" — a silently broken file, worse than the empty-file case refactor: remove per-skill README.md (duplicates SKILL.md) #302 warned about.
  • GitHub folder-browse does not render a symlinked README, so the intended benefit (folder shows content) isn't delivered anyway.
  • These ship as plugins; symlink handling across marketplace build + npm packaging is inconsistent cross-OS.

#302 itself flagged this ("symlinks are fragile across OSes; must not produce an empty file... drop the README entirely"). Closing to avoid two solutions to one issue.

@blafourcade blafourcade closed this Jul 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants